home *** CD-ROM | disk | FTP | other *** search
/ Info-Mac 4 / Info_Mac IV CD-ROM (Pacific HiTech Inc.)(August 1994).iso / Science / RLaB / doc / rlab.1 < prev    next >
Text File  |  1994-04-25  |  5KB  |  189 lines
  1. .TH RLAB 1  "10 January 1994" "Version 0.97 beta" "USER COMMANDS"
  2. .\" strings
  3. .ds ex \fIexpr\fR
  4. .SH NAME
  5. RLaB \- matrix oriented, interactive programming environment
  6.  
  7. .SH SYNOPSIS
  8. .B rlab
  9. [\-\fBVdhlmnpqr]
  10. [file(s)]
  11. [\-]
  12. .SH DESCRIPTION
  13. .B rlab
  14. is an interpreter for the RLaB Programming Language/Environment. 
  15. The RLaB language is useful for matrix or array oriented numerical
  16. analyses. RLaB is especially useful for prototyping and experimenting 
  17. with algorithms.
  18.  
  19. .B rlab
  20. also provides a convenient
  21. interface to many of the LAPACK,
  22. FFTPACK, and RANLIB subroutines. 
  23.  
  24. .SH OPTIONS
  25.  
  26. .TP
  27. \-\fBV
  28. Prints the version number to stderr and exits.
  29. .TP
  30. \-\fBd
  31. causes a readable form of the internal stack machine's compiled program
  32. to be output to stderr. This option should be used in conjunction with
  33. `-qln' options. This option is not intended for general use.
  34. .TP
  35. \-\fBh
  36. prints the usage message to the screen and exits.
  37. .TP
  38. \-\fBl
  39. prevents loading of the rlab library of rfiles.
  40. .TP
  41. \-\fBm
  42. prevents printing of the greeting message.
  43. .TP
  44. \-\fBn
  45. prevents line number and file name information from being used in the
  46. internal stack machine codes. This option should only be used with the
  47. `-dlnq'. This option is not intended for general use.
  48. .TP
  49. \-\fBp
  50. prevents rlab from using the specified pager for all output.
  51. .TP
  52. \-\fBq
  53. prevents loading of the startup file
  54. .TP
  55. \-\fBr
  56. prevents usage of the GNU readline library for 
  57. command line editing. 
  58. .TP
  59. \fBfile(s)
  60. are loaded and executed by rlab after the `.rlab' file, and after the
  61. library files.
  62. .TP
  63. \-\fB
  64. forces rlab to go interactive after all the files on the command line
  65. have been executed.
  66.  
  67. .SH ENVIRONMENT
  68.  
  69. .B rlab
  70. checks the values of several environment variables upon
  71. startup, and uses them to overide the compiled in defaults. If a
  72. particular environment variable has not been set, the default value is
  73. used.
  74.  
  75. .B RLAB_RC0
  76. Startup rfile.
  77.  
  78. .B RLAB_HELP_DIR
  79. The principle directory of help files.
  80.  
  81. .B RLAB_LIB_DIR
  82. The directory of rfiles to load on startup.
  83.  
  84. .B RLAB_PAGER
  85. The pager to use for paging help 
  86. files to the screen. If 
  87. .B RLAB_PAGER 
  88. is not set, then the environment is checked for 
  89. .B PAGER .
  90. If neither exists, then the pager specified at compile time
  91. is used.
  92.  
  93. .B RLAB_SEARCH_PATH
  94. The set of directories to search when attempting to load rfiles.
  95.  
  96. .SH EXECUTION
  97. .B rlab 
  98. is normally executed from a shell command line. Upon startup
  99. .B rlab 
  100. .nf
  101. .sp
  102. Processes the command line options.
  103.  
  104. Executes the `.rlab' file.
  105.  
  106. Executes any `.r' files in the library directory.
  107.  
  108. Executes any files specified on the command line.
  109.  
  110. Goes into interactive mode if no files are specified on the 
  111. command line, or if the `-' option is used.
  112. .sp
  113. .fi
  114. .B rlab
  115. can also be invoked by using the `#!' convention employed by exec(2).
  116. A 
  117. .B rlab
  118. script that begins with a line of the form:
  119. .nf
  120. .sp
  121.     #! pathname [arg]
  122. .sp
  123. .fi
  124. where \fIpathname\fR is the full pathname to the
  125. .B rlab
  126. executable, and \fIarg\fR is optional argument(s). Note that if the
  127. `-' option is not specified
  128. .B rlab
  129. will not go interactive after the script has been executed.
  130.  
  131. .SH DOCUMENTATION
  132. .B rlab
  133. has an on-line help system, which can be accessed by typing `help'. A
  134. tutorial and a reference manual are currently being worked on.
  135.  
  136. This man-page was not intended to provide a description of
  137. the language, or rlab's features. Please refer to the manuals, or the
  138. on-line help.
  139.  
  140. .SH BUGS
  141. Paged output gets hosed after an `out of memory' message. 
  142.  
  143. .B rlab
  144. implements fprintf(), printf() and sprintf() using the 
  145. C library functions, fprintf, printf and sprintf, so 
  146. .B rlab
  147. inherits any bugs or limitations of the library functions.
  148.  
  149. Using the load() function on the same line as another expression may
  150. cause the other expression to be ignored. For example:
  151.  
  152. .nf
  153. .sp
  154.     load ("test.r"); a = 100
  155. .sp
  156. .fi
  157.  
  158. Will result in the second expression being ignored. This is caused by
  159. the original syntax being used with the new parser/machine capability.
  160. What happens: the tokens for the second expression get wiped out when
  161. the parser is called to start parsing the statements in test.r. The
  162. workaround is simple; don't put calls to load() on the same line as
  163. other expressions. This bug will be fixed in one or two releases.
  164.  
  165. Send bug reports to: ians@eskimo.com. 
  166.  
  167. Bug reports should include the rlab version number, a short rfile that
  168. exercises the bug, and a description of the host operating system and
  169. hardware. 
  170.  
  171. .SH AUTHORS
  172. Ian Searle (ians@eskimo.com)
  173.  
  174. Phillip Musumeci is the author of the RLaB Tutorial (Not Available Yet)
  175.  
  176. Brad Hards is the author of the RLaB Reference Manual (Not Available Yet)
  177.  
  178. Mike Brennan has contributed some code from mawk.
  179.  
  180. .SH SEE ALSO
  181. .I sh
  182. (1)
  183. .I more
  184. (1)
  185. .I exec
  186. (2)
  187. .PP
  188.  
  189.